From: tsteven4 Date: Wed, 3 Apr 2019 23:16:37 +0000 (-0600) Subject: add documentation for some options. (#334) X-Git-Tag: archive/raspbian/1.10.0+ds-2+rpi1~1^2~12^2~8^2~13 X-Git-Url: https://dgit.raspbian.org/%22http:/www.example.com/cgi/%22https://%22Program/%22http:/www.example.com/cgi/%22https:/%22Program?a=commitdiff_plain;h=281597315fe0b920887d3483d0286d07993fbe7a;p=gpsbabel.git add documentation for some options. (#334) * add documentation for some options. garmin_gpi: languagecode gpx: elevprec * doc wording tweak. * delete obsolete unused lowranceusr option, and document new lowranceusr options. * tweak doc. --- diff --git a/lowranceusr.cc b/lowranceusr.cc index e51acca31..a1c26da69 100644 --- a/lowranceusr.cc +++ b/lowranceusr.cc @@ -329,7 +329,6 @@ static char* opt_ignoreicons; static char* opt_writeasicons; static char* opt_seg_break; static char* opt_wversion; -static char* opt_rversion; static char* opt_title; static char* opt_content_descr; static char* opt_serialnum; @@ -722,12 +721,6 @@ arglist_t lowranceusr_args[] = { "break", &opt_seg_break, "(USR input) Break segments into separate trails", nullptr, ARGTYPE_BOOL, ARG_NOMINMAX, nullptr }, - { - // Specify the Input USR Version to be interpreted - // Obsolete option that is ignored - "rversion", &opt_rversion, "(USR input) Read version", - "", ARGTYPE_STRING, ARG_NOMINMAX, nullptr - }, { // Specify the Output USR Version to be generated "wversion", &opt_wversion, "(USR output) Write version", diff --git a/xmldoc/formats/options/garmin_gpi-languagecode.xml b/xmldoc/formats/options/garmin_gpi-languagecode.xml new file mode 100644 index 000000000..87c966edc --- /dev/null +++ b/xmldoc/formats/options/garmin_gpi-languagecode.xml @@ -0,0 +1,34 @@ + +Garmin points of interest files may contain data in two languages. +If you attempt to read a dual language Garmin points of interest file without specifiying which language +to use GPSBabel will print an error message containing the language codes used in the file. +Subsequently you may use one of these codes with the languagecode +option to specify which language to use. + + + Example with unspecified language and a garmin points of interest dual language file. + + + gpsbabel -i garmin_gpi -f reference/spb_metro_norm.gpi + + could produce the following output: + + garmin_gpi: Must select language code, RU and EN found. + + + + + Example for specifying language with a garmin points of interest dual language file. + + + gpsbabel -i garmin_gpi,languagecode=EN -f reference/spb_metro_norm.gpi + + could produce the following output: + + 59.944070N 30.306680E About Saint-Petersburg Metro - 2016.05/This file represents information about metro stations in aint-Petersburg. Published by NAVICOM, 2016. http://navicom.ru + 59.830660N 30.500100E RYBACKOE/Subway + 59.934430N 30.329950E NEVSKII PROSPEKT/Subway + ... + + + diff --git a/xmldoc/formats/options/gpx-elevprec.xml b/xmldoc/formats/options/gpx-elevprec.xml new file mode 100644 index 000000000..8e08da03f --- /dev/null +++ b/xmldoc/formats/options/gpx-elevprec.xml @@ -0,0 +1,18 @@ + +This option specifies the number of digits to be used when +writing elevation values. +Precision is the number of digits after the decimal point. The default +precision is 3. We limit the number of places we write to improve the +fidelity when round-tripping elevation, reduce file size, and reduce +silliness in files caused by repeating decimals in insignificant +digits. + + +As a guideline, three decimal places is 1 millimeter. +To achieve precision approaching this limit leveling techniques are required. +Precisions beyond this are not currently obtainable. + + +This value is ignored on read and has no impact on the internal +representation of data. + diff --git a/xmldoc/formats/options/lowranceusr-description.xml b/xmldoc/formats/options/lowranceusr-description.xml new file mode 100644 index 000000000..dea5927dc --- /dev/null +++ b/xmldoc/formats/options/lowranceusr-description.xml @@ -0,0 +1,3 @@ + +This option can be used when writing a version 4 or higher Lowrance USR file to set the description text. If the option is not used the description text will be "Waypoints, routes, and trails". + diff --git a/xmldoc/formats/options/lowranceusr-serialnum.xml b/xmldoc/formats/options/lowranceusr-serialnum.xml new file mode 100644 index 000000000..2bd84a936 --- /dev/null +++ b/xmldoc/formats/options/lowranceusr-serialnum.xml @@ -0,0 +1,7 @@ + +This option can be used when writing a version 4 or higher Lowrance +USR file to set the device serial number. +If the option is not used and the source of the data is a Lowrance USR +file with a valid serial number then that serial number will be used, +otherwise a value of 0 will be used. + diff --git a/xmldoc/formats/options/lowranceusr-title.xml b/xmldoc/formats/options/lowranceusr-title.xml new file mode 100644 index 000000000..8d4a09d3c --- /dev/null +++ b/xmldoc/formats/options/lowranceusr-title.xml @@ -0,0 +1,3 @@ + +This option can be used when writing a version 4 or higher Lowrance USR file to set the file title. If the option is not used the title will be "GPSBabel generated USR data file". +